//------------------------------------------------------------------------------
//  <copyright file="LockingControllerMessageHandler.h" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
//  </copyright>
//------------------------------------------------------------------------------

#pragma once

#include "stdafx.h"
#include "FriServer.h"
#include "ControllerClientMessageHandler.h"

/// <summary>
/// A version of ControllerClientMessageHandler that uses a critical section in 
/// ProcessMessage to allow calling from multiple threads.
/// </summary>
class LockingControllerClientMessageHandler : public ControllerClientMessageHandler
{
public:
	/// <summary> Initializes a new instance of the <c>LockingControllerClientMessageHandler</c> class. </summary>
	/// <param name="pSbParams">
	/// Shared buffer information necessary for synchronization
	/// with controller thread.
	/// </param>
	LockingControllerClientMessageHandler(SharedBufferParameters *pSbParams);

	/// <summary> dtor </summary>
	~LockingControllerClientMessageHandler();

	/// <summary>
	/// Process a single message from a client connection.
	/// Response is placed at location indicated by <c>response</c>.  <c>Response</c> must
	/// be pre-allocated.
	/// <param name="pMessage"> Pointer to message to be processed. </param>
	/// <param name="pResponse"> Location to place response.  Must be allocated by caller. </param>
	virtual void ProcessMessage(MessageDescription *pMessage, MessageDescription *pResponse);

private:
	/// <summary> Critical section to protect <c>ProcessMessage</c>. </summary>
	CRITICAL_SECTION processMessageCriticalSection;
};
